///////////////////////////////////////////////////////////////////////////////
// Copyright (c) 2009 Summit Contributors.  
// See: http://code.google.com/p/tyemill/wiki/SummitContributors
//
// The name and logo of Summit are trademarks of TYEMILL, LLC - All Rights 
// Reserved.
//
// Permission is hereby granted, free of charge, to any person obtaining a 
// copy of this software and associated documentation files (the "Software"), 
// to deal in the Software without restriction, including without 
// limitation the rights to use, copy, modify, merge, publish, distribute, 
// sublicense, and/or sell copies of the Software, and to permit persons to 
// whom the Software is furnished to do so, subject to the following 
// conditions:
//
// The above copyright notice and this permission notice shall be included 
// in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 
// DEALINGS IN THE SOFTWARE.
///////////////////////////////////////////////////////////////////////////////

package summit.basecamp.helpers
{
import summit.basecamp.constants.BasecampOperation;
import summit.basecamp.constants.BasecampResource;
import summit.net.BasecampRequest;
import flash.net.URLRequestMethod;

/**
 * Helpers for Basecamp company operations.
 */
public class CompanyHelper
{
	/** @private **/
	private static const PATH_HELPER:String = "/companies/";
	private static const TYPE:String = BasecampResource.COMPANY;
	
	/** @private **/
	public function CompanyHelper()
	{
	}

	/**
	 * Builds a <code>BasecampRequest</code> for reading a list of companies.
	 * 
	 * <p>By default (when not providing a <code>projectId</code>) all 
	 * companies visible to the requesting user are listed.</p>
	 * 
	 * <p>Providing a <code>projectId</code> will list all companies 
	 * associated with the specified project.</p>
	 * 
	 * @param projectId The id of the project from which companies are read.
	 * 
	 * @return A request ready for use with <code>BasecampLoader.load</code>.
	 */
	public static function list(projectId:String = null):BasecampRequest
	{
			// GET /companies.xml -- if null
			// GET /projects/#{project_id}/companies.xml -- with project id
			
			var path:String;
			
			if(!projectId)
			{
				path = "/companies.xml";
			}
			else path = "/projects/" + projectId + "/companies.xml";
			
			return new BasecampRequest(path, URLRequestMethod.GET, 
			TYPE, BasecampOperation.LIST);
	}	
	
	/**
	 * Builds a <code>BasecampRequest</code> for reading a single company.
	 * 
	 * @param id The id of the company to be read.
	 * 
	 * @return A request ready for use with <code>BasecampLoader.load</code>.
	 */

	public static function read(id:String):BasecampRequest
	{
		SharedOperations.nullEmptyAssert(id, "id");
		
		// GET /companies/#{company_id}.xml
		return SharedOperations.read(id, PATH_HELPER, TYPE);
	}
}
}
//////////////////////////////////////////////////////// gmarius@tyemill.com //